home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus Special 23 / AMIGAplus Sonderheft 23 (2000)(Falke)(DE)[!].iso / Updates / DOS / GetType1.13 / GT.doc < prev    next >
Text File  |  1999-11-08  |  22KB  |  554 lines
  1.  
  2.  +--------------------------------------------------------------------------+
  3.  |                    Documentation for GetType 1.13                        |
  4.  |                                                                          |
  5.  |     Program & related files are copyright © 1997-1999 Andrew Bell.       |
  6.  +--------------------------------------------------------------------------+
  7.  
  8.  ----------------------------------------------------------------------------
  9.  DISCLAIMER
  10.  ----------------------------------------------------------------------------
  11.  
  12.  BY USING THIS PROGRAM THE USER ACCEPTS FULL LIABILITY FOR ANY DAMAGE THAT
  13.  COULD POSSIBLY BE CAUSED BY ITS USAGE OR MISUSE. THE AUTHOR OF THIS SOFTWARE
  14.  CANNOT BE HELD RESPONSIBLE FOR ANY DAMAGE.
  15.  
  16.  THIS PROGRAM IS PROVIDED AS-IS. USE THIS PROGRAM AT YOUR OWN RISK.
  17.  
  18.  (After all, you did get it for free!)
  19.  
  20.  ----------------------------------------------------------------------------
  21.  DISTRIBUTION
  22.  ----------------------------------------------------------------------------
  23.  
  24.  IT IS PROHIBITED TO DISTRIBUTE GETTYPE WITHOUT THE FOLLOWING FILES:
  25.  
  26.  GetType/GT
  27.  GetType/GT.doc
  28.  GetType/GT.readme
  29.  GetType/GT_Types.txt
  30.  GetType/Libs/Idm.library
  31.  GetType/Libs/Idm.library.readme
  32.  GetType/Libs/FileID.library
  33.  
  34.  GETTYPE IS FREE, AND NO PROFIT SHOULD BE MADE FROM DISTRIBUTING IT.
  35.  
  36.  ----------------------------------------------------------------------------
  37.  OVERVIEW
  38.  ----------------------------------------------------------------------------
  39.  
  40.  GetType is a CLI/Shell program that enables the user to identify files via
  41.  a Shell/DOS prompt. It requires an 020 processor or better, and at least
  42.  version 39 of the Amiga operation system. It also needs Idm.library version
  43.  1 or later.
  44.  
  45.  The actual identification work is done by Idm.library (and FileID.library /
  46.  xfdmaster.library), currently this library recognizes over 1100 filetypes.
  47.  
  48.  Using the UFID and UXFD, you check now check files with a database of over
  49.  2000 filetypes.
  50.  
  51.  I recommend using an 030 CPU or better.
  52.  
  53.  ----------------------------------------------------------------------------
  54.  INSTALLATION
  55.  ----------------------------------------------------------------------------
  56.  
  57.  Simply copy the executable (GT) to the C: drawer, and Idm.library to the
  58.  LIBS: drawer. Copy FileID.library to LIBS: also, but check to see if you
  59.  already have a higher version already installed, if so you don't need to
  60.  install it.
  61.  
  62.  ----------------------------------------------------------------------------
  63.  PROGRAM USAGE
  64.  ----------------------------------------------------------------------------
  65.  
  66.  Once installation has been completed, you can now start the program. Simply
  67.  type GT at the Shell/DOS prompt to start it.
  68.  
  69.  The command line is as follows:
  70.  
  71.  DIR/M
  72.  
  73.   Use this parameter to provide the locations of the files and dirs to
  74.   scan.
  75.  
  76.  ALL/S
  77.  
  78.   Enter into sub-directories. When using this option the output can be a
  79.   little confusing on big HDs with deep directory trees.
  80.  
  81.   If you don't like the output, consider using the LFMT parameter. The
  82.   ALL option is not really designed to be used with the default output.
  83.  
  84.  HL_U/S
  85.  
  86.   Highlight unknown files.
  87.  
  88.  HL_K/S
  89.  
  90.   Highlight known files.
  91.  
  92.  HELP/S
  93.  
  94.   A simple help page giving details on the parameters.
  95.  
  96.  INFO/S
  97.  
  98.   More information on the currently installed version of Idm.library.
  99.  
  100.  TYPES/S
  101.  
  102.   Display a (very long) list of all the filetypes known to the currently
  103.   installed version of Idm.library. If this list is too long, then press
  104.   CONTROL+C to break.
  105.  
  106.  IDPAT/K
  107.  
  108.   An AmigaDOS pattern/wildcard string, used for finding certain filetypes.
  109.   For example, if you wanted to view only the filetypes recognized by
  110.   FileID.library then type something similar to this:
  111.  
  112.   GT <PutPathHere> <PutOptionsHere> UFID IDPAT=FID:#?
  113.  
  114.   Note: Uppercase and lowercase are both treated as the same.
  115.  
  116.  DGEN/S
  117.  
  118.   Display general filetypes (Executable/Data) instead of a question mark '?'.
  119.  
  120.  SC=SETCOMMENT/S
  121.  
  122.   Set file's comment with identification string. Don't use this feature if
  123.   you place great value on your file comments.
  124.  
  125.  SI=SHOWICONS/S
  126.  
  127.   Show #?.info files. By default GetType does not show icon files.
  128.  
  129.  IOLEN/N
  130.  
  131.   Specify a new read length. This value sets the amount of bytes to be loaded
  132.   off the start of each file, while scanning. Idm.library requires GT to load
  133.   about 2Kb from the start of each file in order to identify it. By using
  134.   this option you can force GT to load a smaller amount of bytes from each
  135.   file, doing this will result in less files being identified but a faster
  136.   performance.
  137.  
  138.   Any number below 4 will become 4.
  139.  
  140.   NOTE: If you use the UFID option the IOLEN parameter will be forced to at
  141.         least 1200 bytes. This is required because FileID.library needs a
  142.         minimum of 1200 bytes to be loaded off the start of each file, to
  143.         ensure a proper identification check.
  144.  
  145.         This is also the same for xfdmaster.library, about 5KB is required
  146.         for proper identification when using the UXFD=USEXFD/S parameter.
  147.  
  148.   For the best result, don't use either the UFID or UXFD parameters with the
  149.   IOLEN parameter.
  150.  
  151.  UFID=USEFILEID/S 
  152.  
  153.   Tells GT to use FileID.library for any unknown filetype encountered. v8+ of
  154.   this library is required. Any IDs made by this library will have a 'FID:'
  155.   prefix for clarity (except for LFMT's %2 code).
  156.  
  157.  LFMT/K
  158.  
  159.   Perhaps one of GTs more powerful parameters, using this parameter allows
  160.   the user to create simple script/batch files or configure the output. At
  161.   the moment the default output is very ugly, so you might want to consider
  162.   using this option :) especially if you are using DOpus, DirWork, etc.
  163.  
  164.   This parameter is similar to the LIST command's LFORMAT parameter. The user
  165.   will pass a formatted string and GT will parse it with the desired
  166.   information.
  167.  
  168.   So for example if we wanted to delete all StoneCracker compressed files
  169.   in the C: drawer, we could type the following at a Shell prompt:
  170.  
  171.   GT c: all lfmt="delete %p%n FORCE" idpat=#?stc#? >ram:tempscriptfile
  172.   execute ram:tempscriptfile
  173.   delete ram:tempscriptfile
  174.  
  175.   In order to build the output string via the LFMT parameter we need
  176.   to know what format components codes are available:
  177.  
  178.   %% = insert a literal % character
  179.   %P = insert full path (same as %p%n, eg: dh0:mydrawer/myfile)
  180.   %p = insert path string (eg: dh0:mydrawer/)
  181.   %n = insert filename string (eg: myfile)
  182.   %l = insert entry type string (eg: F, LF, PF, etc.)
  183.   %s = insert size in bytes string (eg: 153432)
  184.   %S = insert size string (rounds off lengths to K, MB, GB, etc.)
  185.   %i = insert primary identifcation string.
  186.   %1 = insert identification result of Idm.lib
  187.   %2 = insert identification result of FileID.lib (without FID: prefix)
  188.   %3 = insert identification result of GT name matching.
  189.   %4 = insert identification result of xfdmaster.lib (without XFD: prefix)
  190.   %c = insert file comment.
  191.   %b = insert the amount of blocks the file takes up.
  192.  
  193.   If you insert a '-' and THREE decimal digits immediately after the '%' you
  194.   can specify the width in characters you wish the string to fill. The
  195.   remainder of the string will be padded with spaces. This will let you
  196.   create more readable strings, but is not much use when creating script
  197.   files (as shown above).
  198.  
  199.   Remember when using the '-' symbol that you MUST put three decimal digits
  200.   after it. So NEVER use %-8n, use %-008n instead.
  201.  
  202.   If you want a full path use %P and not %p%n, remember these format codes
  203.   are case sensitive. I hear you ask: What is the point of having %P when
  204.   %p%n does the same job? Well the answer is: %P works better with the
  205.   '-' symbol. Simple.
  206.  
  207.   If the string is bigger than the number you pass with the '-' symbol, then
  208.   the bounds will be broken. If you want to limit the amount of characters
  209.   inserted, then you can append a '.' (period) followed by a THREE digit
  210.   number that will specify the maximum allowed characters.
  211.  
  212.   It you need spaces in you LFMT string remember to enclose it in "double
  213.   quotes" (eg: LFMT="File %n is %i").
  214.  
  215.   If all this seems complicated, thats because it is :) This parameter is
  216.   for the advanced Amiga user only.
  217.  
  218.   Believe it or not, bu